Episode 34 “Doc, JavaDoc and Markdown” with Jonathan Gibbons

Java leads by example regarding documentation: JavaDoc inspires trust in developers through its transparency on each Java API functionality, and the javadoc tool helps developers generate equally great documentation for their APIs and libraries.

In this episode, Ana hosts Jonathan Gibbons, core contributor and maintainer of JDK tools, to discuss JavaDoc/javadoc developments, focusing on markdown in JavaDoc documentation comments. Given the importance of having code that is as easy to understand as it is functional, Jonathan dives into significant changes in Java’s documentation component and associated tools, how JavaDoc is maintained, code documentation practices, and more.

Make sure to also check the Duke’s Corner podcast on dev.java.

Show Notes

• JEP 467
• How to Write Doc Comments for the JavaDoc Tool
• JavaDoc Tool guide
• Standard Doclet Specifications

Additional resources

• Dev.java : The Destination for Java Developers
• OpenJDK
• Oracle Java

For more episodes, check out Inside Java, our YouTube playlist, and follow @Java on Twitter.

Contact us here.